From ccaf8429198d0ab329a202979973e4bf71aafb78 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Sun, 3 Oct 2010 00:58:38 +0200 Subject: [PATCH] docs: Move documentation to inline comments: GtkTooltip --- docs/reference/gtk/tmpl/.gitignore | 1 + docs/reference/gtk/tmpl/gtktooltip.sgml | 173 ------------------------ gtk/gtktooltip.c | 66 +++++++++ 3 files changed, 67 insertions(+), 173 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtktooltip.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 57eac13dc6..4919a5f99c 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -42,6 +42,7 @@ gtktexttagtable.sgml gtktoggleaction.sgml gtktoolbar.sgml gtktoolitem.sgml +gtktooltip.sgml gtktreednd.sgml gtktypeutils.sgml gtkwindow.sgml diff --git a/docs/reference/gtk/tmpl/gtktooltip.sgml b/docs/reference/gtk/tmpl/gtktooltip.sgml deleted file mode 100644 index 15a8f4374b..0000000000 --- a/docs/reference/gtk/tmpl/gtktooltip.sgml +++ /dev/null @@ -1,173 +0,0 @@ - -GtkTooltip - - -Add tips to your widgets - - - -#GtkTooltip belongs to the new tooltips API that was -introduced in GTK+ 2.12 and which deprecates the old -#GtkTooltips API. - - -Basic tooltips can be realized simply by using gtk_widget_set_tooltip_text() -or gtk_widget_set_tooltip_markup() without any explicit tooltip object. - - - -When you need a tooltip with a little more fancy contents, like -adding an image, or you want the tooltip to have different contents -per GtkTreeView row or cell, you will have to do a little more work: - - - -Set the #GtkWidget:has-tooltip property to %TRUE, this will -make GTK+ monitor the widget for motion and related events -which are needed to determine when and where to show a tooltip. - - - -Connect to the #GtkWidget::query-tooltip signal. This signal -will be emitted when a tooltip is supposed to be shown. One -of the arguments passed to the signal handler is a #GtkTooltip -object. This is the object that we are about to display as a -tooltip, and can be manipulated in your callback using functions -like gtk_tooltip_set_icon(). There are functions for setting -the tooltip's markup, setting an image from a stock icon, or -even putting in a custom widget. - - - -Return %TRUE from your query-tooltip handler. This causes -the tooltip to be show. If you return %FALSE, it will not be shown. - - - - - -In the probably rare case where you want to have even more control -over the tooltip that is about to be shown, you can set your own -#GtkWindow which will be used as tooltip window. This works as -follows: - - - -Set #GtkWidget:has-tooltip and connect to #GtkWidget::query-tooltip as -before. - - - -Use gtk_widget_set_tooltip_window() to set a #GtkWindow created -by you as tooltip window. - - - -In the ::query-tooltip callback you can access your window -using gtk_widget_get_tooltip_window() and manipulate as you -wish. The semantics of the return value are exactly as before, -return %TRUE to show the window, %FALSE to not show it. - - - - - - - - - - - - - - - - - - - - - - - - - - -@tooltip: -@markup: - - - - - - - -@tooltip: -@text: - - - - - - - -@tooltip: -@pixbuf: - - - - - - - -@tooltip: -@stock_id: -@size: - - - - - - - -@tooltip: -@icon_name: -@size: - - - - - - - -@tooltip: -@gicon: -@size: - - - - - - - -@tooltip: -@custom_widget: - - - - - - - -@display: - - - - - - - -@tooltip: -@rect: - - diff --git a/gtk/gtktooltip.c b/gtk/gtktooltip.c index faa45a8fe3..8ef7754dde 100644 --- a/gtk/gtktooltip.c +++ b/gtk/gtktooltip.c @@ -36,6 +36,72 @@ #include "gtksizerequest.h" +/** + * SECTION:gtktooltip + * @Short_description: Add tips to your widgets + * @Title: GtkTooltip + * + * Basic tooltips can be realized simply by using gtk_widget_set_tooltip_text() + * or gtk_widget_set_tooltip_markup() without any explicit tooltip object. + * + * When you need a tooltip with a little more fancy contents, like adding an + * image, or you want the tooltip to have different contents per #GtkTreeView + * row or cell, you will have to do a little more work: + * + * + * + * Set the #GtkWidget:has-tooltip property to %TRUE, this will make GTK+ + * monitor the widget for motion and related events which are needed to + * determine when and where to show a tooltip. + * + * + * + * + * Connect to the #GtkWidget::query-tooltip signal. This signal will be + * emitted when a tooltip is supposed to be shown. One of the arguments passed + * to the signal handler is a GtkTooltip object. This is the object that we + * are about to display as a tooltip, and can be manipulated in your callback + * using functions like gtk_tooltip_set_icon(). There are functions for setting + * the tooltip's markup, setting an image from a stock icon, or even putting in + * a custom widget. + * + * + * + * + * Return %TRUE from your query-tooltip handler. This causes the tooltip to be + * show. If you return %FALSE, it will not be shown. + * + * + * + * + * In the probably rare case where you want to have even more control over the + * tooltip that is about to be shown, you can set your own #GtkWindow which + * will be used as tooltip window. This works as follows: + * + * + * + * Set #GtkWidget:has-tooltip and connect to #GtkWidget::query-tooltip as + * before. + * + * + * + * + * Use gtk_widget_set_tooltip_window() to set a #GtkWindow created by you as + * tooltip window. + * + * + * + * + * In the #GtkWidget::query-tooltip callback you can access your window using + * gtk_widget_get_tooltip_window() and manipulate as you wish. The semantics of + * the return value are exactly as before, return %TRUE to show the window, + * %FALSE to not show it. + * + * + * + */ + + #undef DEBUG_TOOLTIP -- 2.30.2